home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / pkmas300.arc / PKMAS.TXT < prev    next >
Text File  |  1991-10-15  |  22KB  |  677 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.                   ═════════════════════════════════
  18.                      PKSOFT MULTI-ARCHIVE SYSTEM
  19.                     (c)Copyright PKsoft 1990-1991
  20.                         Written by Kelvin Goh
  21.                   ═════════════════════════════════
  22.  
  23.                    PKsoft Multi-ARChive System(R)
  24.  
  25.  
  26.                           LICENSE STATEMENT
  27.  
  28.  
  29.     PKsoft & the  author hereby grants  a non-exclusive license  to us
  30.     the  PKsoft  Multi-ARChive  System  package,  including  all   its
  31.     documentation.  The software may be used on any computer under the
  32.     direct control of the licensee, provided that the software  cannot
  33.     possible be used on omore than  one computer and by more than  one
  34.     user at the same time unless otherwised stated.
  35.  
  36.     The software  may not  be disassembled  or reversed  engineered by
  37.     electronic or any other means.
  38.  
  39.     Copies of the software may be made for the sole purpose of backup,
  40.     archive or distribution but  not for commercial sale,  without the
  41.     prior written consent of PKsoft or the author.
  42.  
  43.  
  44.                               WARRENTY
  45.  
  46.     PKsoft and the author  hereby explicitly disclaim all  warranties,
  47.     whether expressed or  implied, including, without  limitation, the
  48.     implied  warranties  of  merchantability   and  fitness  for   any
  49.     particular purpose.  PKsoft or the author shall not be liable  for
  50.     consequential,   incidental,   examplary,   or   special  damages,
  51.     including loss of profits.
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.          Dedecated to:
  70.  
  71.               The late Mr Ravi Kuppusamy who passed away peacefully on
  72.          8 Aug 91.  A dear friend who will be sadly missed.
  73.  
  74.               My parents for their encouragement to strive  throughout
  75.          the years.
  76.  
  77.  
  78.  
  79.                                                               CONTENTS
  80.     ══════════════════════════════════════════════════════════════════
  81.  
  82.          Introduction . . . . . . . . . . . . . . . . . . . 1 - 1
  83.               Package Contents. . . . . . . . . . . . . . . 1 - 1
  84.               Environment . . . . . . . . . . . . . . . . . 1 - 1
  85.               Overview. . . . . . . . . . . . . . . . . . . 1 - 2
  86.  
  87.          Setup. . . . . . . . . . . . . . . . . . . . . . . 2 - 1
  88.               Main Menu . . . . . . . . . . . . . . . . . . 2 - 1
  89.               Address . . . . . . . . . . . . . . . . . . . 2 - 1
  90.               Paths . . . . . . . . . . . . . . . . . . . . 2 - 1
  91.               Compression . . . . . . . . . . . . . . . . . 2 - 2
  92.               Defaults. . . . . . . . . . . . . . . . . . . 2 - 3
  93.               Registration. . . . . . . . . . . . . . . . . 2 - 3
  94.               PKNODE.CTL. . . . . . . . . . . . . . . . . . 2 - 4
  95.               System Setup. . . . . . . . . . . . . . . . . 2 - 4
  96.  
  97.          Registration Information . . . . . . . . . . . . . 3 - 1
  98.               Registration Information. . . . . . . . . . . 3 - 1
  99.  
  100.          Appendix A . . . . . . . . . . . . . . . . . . . . 4 - 1
  101.               Bundle Calculation. . . . . . . . . . . . . . 4 - 1
  102.  
  103.          Appendix B . . . . . . . . . . . . . . . . . . . . 4 - 2
  104.               IMAIL/TosScan Support . . . . . . . . . . . . 4 - 2
  105.  
  106.          Appendix C . . . . . . . . . . . . . . . . . . . . 4 - 3
  107.               Features List . . . . . . . . . . . . . . . . 4 - 3
  108.  
  109.          Appendix D . . . . . . . . . . . . . . . . . . . . 4 - 4
  110.               Credits . . . . . . . . . . . . . . . . . . . 4 - 4
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.     ══════════════════════════════════════════════════════════════════
  125.                                                               CONTENTS
  126.  
  127.  
  128.  
  129.     PKMAS USERS' GUIDE                                          1 - 1
  130.     ══════════════════════════════════════════════════════════════════
  131.  
  132.                                                          INTRODUCTION
  133.  
  134.     Package Contents
  135.     ──────────────────────────────────────────────────────────────────
  136.  
  137.               The following are the contents of the PKMAS package.  If
  138.          you find or suspect any discrepancies, please don't  hasitate
  139.          to  call  The  HOST  Connection  @  6:600/400 or any official
  140.          distribution site to pick up the original package.
  141.  
  142.          Program Name        Description
  143.          ------------        -----------------------------------------
  144.          PKCOMPAK.COM        Compression Routine
  145.          PKEXTRCT.COM        Extraction Routine
  146.          PKCONFIG.EXE        Configuration Program
  147.          PKCONFIG.HLP        Context Sensitive Help File
  148.          PKNODE.CTL          Example Node Control File
  149.          PKMAS.TXT           Program Documentation
  150.          CHANGES.TXT         Program History/Changes
  151.          REGISTER.TXT        Registration Form
  152.  
  153.     ══════════════════════════════════════════════════════════════════
  154.     Environment
  155.     ──────────────────────────────────────────────────────────────────
  156.  
  157.          Minimum hardware requirements:
  158.  
  159.          o    An IBM PC,  AT,, 386, 486, with 100% PC BIOS  compatible
  160.          computer with at least 300KB available memory.
  161.  
  162.          o    A monochrome or color monitor.
  163.  
  164.          o    A mouse (optional)
  165.  
  166.  
  167.          Minimum software requirements:
  168.  
  169.          o    MS or PC-DOS 3.10 or later, or DR-DOS 5.00 or later.
  170.  
  171.          o    An echomail processor like Zmail(tm) or ConfMail(tm);
  172.          Zmail is prefered.
  173.  
  174.     ══════════════════════════════════════════════════════════════════
  175.                                                           INTRODUCTION
  176.  
  177.  
  178.  
  179.     1 - 2                                          PKMAS USERS' GUIDE
  180.     ══════════════════════════════════════════════════════════════════
  181.  
  182.  
  183.     Overview
  184.     ──────────────────────────────────────────────────────────────────
  185.  
  186.               PKMAS was written to meet the needs of memory hungry
  187.          Sysops, running multi-line systems.  The package takes
  188.          advantage of memory overlays and executes a program directly
  189.          instead of using the COMMAND.COM!  This effectively reduces
  190.          memory usage to a bare 20KB, and this is overlayed when the
  191.          archive program runs.
  192.  
  193.               To assist in  configurations, a specially  written setup
  194.          program was incorporated.  This program features, among other
  195.          things  full  mouse  support,  DESQview(tm)  buffered  screen
  196.          writes, context sensitive help and automatic video detection.
  197.          This should help most  first time BBS operators  to configure
  198.          this software with at little hassle as possible.
  199.  
  200.               Much time and effort  has gone into the  programming and
  201.          beta testing  of this  software.   I would  like to take this
  202.          opportunity to thank all my beta testers for their invaluable
  203.          help and suggestions.  Special thanks to:
  204.  
  205.               Pete Franchi @ 2:253/157
  206.               "I'll trash it for you"
  207.  
  208.               Jason Steck @ 1:104/424
  209.               "Let me test it out further"
  210.  
  211.               Peter Tan @ 6:600/403
  212.               "Maybe if you...."
  213.  
  214.               Charles Cheong @ 6:600/307
  215.               "Why not add....."
  216.  
  217.               Robert Prowl
  218.               "Hmmm.  Let me see now...."
  219.  
  220.               Thanks again guys.  Without your help, I guess this
  221.          software will still be on the shelf!
  222.  
  223.  
  224.     ══════════════════════════════════════════════════════════════════
  225.                                                           INTRODUCTION
  226.  
  227.  
  228.  
  229.     2 - 1                                          PKMAS USERS' GUIDE
  230.     ══════════════════════════════════════════════════════════════════
  231.  
  232.                                                                  SETUP
  233.  
  234.     Main Menu
  235.     ──────────────────────────────────────────────────────────────────
  236.  
  237.               To  configure   the  PKMAS   package,  you'll   need  to
  238.          run the PKCONFIG.EXE program.   The  program breaks down  the
  239.          configuration into 5 parts.  They are:
  240.  
  241.          Address        - This is your Primary Network Address.
  242.          Paths          - Defines paths and filenames.
  243.          Compression    - Compression program definition.
  244.          Defaults       - Some system defaults.
  245.          Registration   - To enter your unique registration
  246.                           information.
  247.  
  248.          We will examine each item closely.
  249.  
  250.     ══════════════════════════════════════════════════════════════════
  251.     Address
  252.     ──────────────────────────────────────────────────────────────────
  253.  
  254.               This defines your primary  network address.  It  must be
  255.          in the format ZZZ:NNNN/nnnn.   Any of  the positions  not  in
  256.          use  must  be  filled  by  zeros  (0).   For example, if your
  257.          primary network  address is  6:600/400, then  you would enter
  258.          006:0600/0400.
  259.  
  260.               It  is   essential  that   you  enter ONLY  your primary
  261.          address  because  this   field  is   used  to   calculate the
  262.          origin/destination address from each bundle.
  263.  
  264.     ══════════════════════════════════════════════════════════════════
  265.     Paths
  266.     ──────────────────────────────────────────────────────────────────
  267.  
  268.               Logfile refers to the logfile that you wish to append to
  269.          when PKMAS operates.   By default, the  logfile is  ZMAIL.LOG
  270.          and the path is C:\RA.  You may wish to change this.
  271.  
  272.  
  273.  
  274.  
  275.     ══════════════════════════════════════════════════════════════════
  276.                                                                  SETUP
  277.  
  278.  
  279.  
  280.     2 - 2                                          PKMAS USERS' GUIDE
  281.     ══════════════════════════════════════════════════════════════════
  282.  
  283.  
  284.               Badmail refers  to the  path   (and path  only) to place
  285.          bundles that are  larger then a   given size (see  Defaults).
  286.          These bundles can be  extracted manually  later.   A trailing
  287.          back slash (\) is recommended though not necessary.
  288.  
  289.     ══════════════════════════════════════════════════════════════════
  290.     Compression
  291.     ──────────────────────────────────────────────────────────────────
  292.  
  293.               This  menu  allows   for  a  further   definition  of  5
  294.          compression and  extraction   programs.    By default,    the
  295.          PKMAS   package has   a predefined  set of  archive programs.
  296.          These include:
  297.  
  298.          Label     Program
  299.          -----     ---------------------------------------------------
  300.          LZH       LHA.EXE(tm) v2.12 by Haruyasu Yoshizaki
  301.          ZIP       PKZIP.EXE(tm) v1.1 by PKWARE Inc.
  302.          RZIP      --- As Above --- (For registered PKZIP)
  303.          PAK       PAK.EXE(tm) v2.51 by NoGate Consulting
  304.          ARC       PKPAK.EXE(tm) v3.61 by PKWARE Inc.
  305.          ARJ       ARJ.EXE (tm) v0.20 by Robert K Jung
  306.  
  307.               The above  labels should  never be  used when   defining
  308.          a new archive program.
  309.  
  310.               The fields for the definable compression system are:
  311.  
  312.          Archiver       - The  archive  program name.   No paths   are
  313.                         required as the  program will  search the  DOS
  314.                         path  for the archiver.
  315.  
  316.          UnArchiver     - The   unarchiver program  name.   Again,  no
  317.                         paths  are  required  as   the  program   will
  318.                         search  the DOS path for the unarchiver.
  319.  
  320.          Command Line   - This defines the command line options to  be
  321.                         used by  archiver/unarchiver.    Each   option
  322.                         must   be saparated by a space.
  323.  
  324.  
  325.     ══════════════════════════════════════════════════════════════════
  326.                                                                  SETUP
  327.  
  328.  
  329.  
  330.     2 - 3                                          PKMAS USERS' GUIDE
  331.     ══════════════════════════════════════════════════════════════════
  332.  
  333.  
  334.          Unique Label   - This is  the label that  PKCOMPAK will   use
  335.                         when  it searches  the  PKNODE  (see   PKNODE)
  336.                         file  for the packing method.
  337.  
  338.          ID Bytes       - This is the ID Bytes of the archive program.
  339.                         Only look for bytes that are constant.   Bytes
  340.                         that are  not used  must be  specified as 000.
  341.                         PKEXTRCT searches  only the  first 8  bytes of
  342.                         the  bundle,  so  archive  programs  like  DWC
  343.                         cannot  be  specified  as  it  uses the last 8
  344.                         bytes of the archive.
  345.  
  346.     ══════════════════════════════════════════════════════════════════
  347.     Defaults
  348.     ──────────────────────────────────────────────────────────────────
  349.  
  350.               This  menu  defines  the  Maximum  Bundle  Size  and the
  351.          Logfile type.  The maximum bundle size refers to the size  of
  352.          the archive file  when it arrives  at the system  for further
  353.          processing.  Some sysops  would like to manual  extract large
  354.          bundles.   The maximum  bundle size  is a  figure in  KB to a
  355.          maximum  of  9999KB  or  9.9  MB!   If  these  feature is not
  356.          desirable, it can be turned off by specifying 0000.
  357.  
  358.               Logfile type refers to the logging method to be used  by
  359.          the program.   At present, only  OPUS(tm)/BinkleyTERM(tm) and
  360.          FrontDoor(tm) logging systems are supported.
  361.  
  362.     ══════════════════════════════════════════════════════════════════
  363.     Registration
  364.     ──────────────────────────────────────────────────────────────────
  365.  
  366.               This menu is used to enter your registration information
  367.          once you have received your registration key.  The Registered
  368.          Name and BBS Name *MUST* be exactly the same as that used  in
  369.          your  registration  form.   This  includes   capitalisations.
  370.          Please refer to the  section on Registration Information  for
  371.          more information.
  372.  
  373.  
  374.  
  375.     ══════════════════════════════════════════════════════════════════
  376.                                                                  SETUP
  377.  
  378.  
  379.  
  380.     2 - 4                                          PKMAS USERS' GUIDE
  381.     ══════════════════════════════════════════════════════════════════
  382.  
  383.  
  384.     PKNODE.CTL
  385.     ──────────────────────────────────────────────────────────────────
  386.  
  387.               The  PKNODE.CTL  file  defines  that  packing method for
  388.          individual nodes and the default packing method.  The  format
  389.          is as follows:
  390.  
  391.          [-<Label>]
  392.          [<Net/Node>]
  393.          .
  394.          .
  395.          [-<Label>]
  396.          [<Net/Node>]
  397.          .
  398.          .
  399.          -<Default Label>
  400.  
  401.               The Default  Label is  necesary and  *MUST* be  the last
  402.          label.  If this file  is missing, the program will  exit with
  403.          an error status.  Here is a working example:
  404.  
  405.          -LZH
  406.          600/403
  407.          -ARC
  408.          600/2
  409.          -RZIP
  410.  
  411.     ══════════════════════════════════════════════════════════════════
  412.     System Setup
  413.     ──────────────────────────────────────────────────────────────────
  414.  
  415.               It is absolutely essential  that the DOS APPEND  command
  416.          must be used to specify  the path of the above  configuration
  417.          files.  This  is because the  program will search  the append
  418.          path for its configuration files and if it cannot find it, it
  419.          will exit with an error.
  420.  
  421.  
  422.  
  423.  
  424.  
  425.     ══════════════════════════════════════════════════════════════════
  426.                                                                  SETUP
  427.  
  428.  
  429.  
  430.     3 - 1                                          PKMAS USERS' GUIDE
  431.     ══════════════════════════════════════════════════════════════════
  432.  
  433.                                               REGISTRATION INFORMATION
  434.  
  435.     Registration Information
  436.     ──────────────────────────────────────────────────────────────────
  437.  
  438.               You may use the PKMAS package without register  yourself
  439.          with us.  However,  an unregistered package will  not support
  440.          the  definable  compression  system.   Registration  of  this
  441.          package  is  US$10  and  can  be  registered  at  one  of the
  442.          designated  registration  sites.   Those  who  do not wish to
  443.          register  this  package,  are  requested  to  at least send a
  444.          postcard to me, letting me know your name, network address  &
  445.          BBS  name.   You  can  mail  your  postcard  to  the Far East
  446.          Registration address.
  447.  
  448.               Those wishing to register  this package, please fill  in
  449.          the REGISTER.TXT file and send it to:
  450.  
  451.          FAR EAST (ASIA)
  452.          Kelvin Goh
  453.          Toa Payoh Central PO Box 0238
  454.          Singapore 9131
  455.          Republic of Singapore
  456.  
  457.          EUROPE
  458.          Dealer/Distributor not appointed
  459.  
  460.          USA
  461.          Dealer/Distributor not appointed
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.     ══════════════════════════════════════════════════════════════════
  476.                                               REGISTRATION INFORMATION
  477.  
  478.  
  479.  
  480.     4 - 1                                          PKMAS USERS' GUIDE
  481.     ══════════════════════════════════════════════════════════════════
  482.  
  483.                                                             APPENDIX A
  484.  
  485.     Bundle Calculation
  486.     ──────────────────────────────────────────────────────────────────
  487.  
  488.               Many have  wondered how  the mail  bundle is calculated.
  489.          It is in fact a very simple method.  The formula is:
  490.  
  491.          Net  = Origin Net  - Destination Net (in HEX)
  492.          Node = Origin Node - Destination Node (in HEX)
  493.  
  494.               The  first  4  characters  are  the  Net  and the last 4
  495.          characters are  the node.   The extension  is the  day of the
  496.          week (first 2 letters) and the number of the bundle for  that
  497.          day.  So if  your address is 600/400  and you are sending  to
  498.          609/69, and it was a Tuesday, then:
  499.  
  500.          Net  = 0x0258 - 0x0261
  501.          Net  = 0xfff7
  502.  
  503.          Node = 0x0190 - 0x0045
  504.          Node = 0x014b
  505.  
  506.          Bundle Name = fff7014b.tu1
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.     ══════════════════════════════════════════════════════════════════
  526.                                                             APPENDIX A
  527.  
  528.  
  529.  
  530.     4 - 2                                          PKMAS USERS' GUIDE
  531.     ══════════════════════════════════════════════════════════════════
  532.  
  533.                                                             APPENDIX B
  534.  
  535.     IMAIL/TosScan Support
  536.     ──────────────────────────────────────────────────────────────────
  537.  
  538.               Because of TosScan's design,  it is necessary to  modify
  539.          an IMAIL packet to that  it could be read by  TosScan without
  540.          being rejected.  This is done by changing the Product Code ID
  541.          from 0x4b  to 0x3f.   Until TosScan  is rewritten  to  accept
  542.          IMAIL packets, the PKMAS package continue to change the IMAIL 
  543.          product code to TosScan's product code.
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.     ══════════════════════════════════════════════════════════════════
  576.                                                             APPENDIX B
  577.  
  578.  
  579.  
  580.     4 - 3                                          PKMAS USERS' GUIDE
  581.     ══════════════════════════════════════════════════════════════════
  582.  
  583.                                                             APPENDIX C
  584.  
  585.     Features List
  586.     ──────────────────────────────────────────────────────────────────
  587.  
  588.               The following  are some  of the  unique features  of the
  589.          PKMAS package:
  590.  
  591.  
  592.               o    Full  screen configuration  program with  mouse   &
  593.               DESQview (tm) support.
  594.  
  595.               o    Runs on just 20KB  of memory with full  overlay  to
  596.               reduce memory usage.
  597.  
  598.               o    Moves large bundles offline for manual unpacking if
  599.               desired.
  600.  
  601.               o    Linked to a binary format for faster operations.
  602.  
  603.               o    Logs   bundle  information  and   packing/unpacking
  604.               methods.
  605.  
  606.  
  607.  
  608.  
  609.  
  610.  
  611.  
  612.  
  613.  
  614.  
  615.  
  616.  
  617.  
  618.  
  619.  
  620.  
  621.  
  622.  
  623.  
  624.  
  625.     ══════════════════════════════════════════════════════════════════
  626.                                                             APPENDIX C
  627.  
  628.  
  629.  
  630.     4 - 4                                          PKMAS USERS' GUIDE
  631.     ══════════════════════════════════════════════════════════════════
  632.  
  633.                                                             APPENDIX D
  634.  
  635.     Credits
  636.     ──────────────────────────────────────────────────────────────────
  637.  
  638.          Mike Smedley  for his  development of  C eXtended Librarires,
  639.          which this software depends quite greatly on.
  640.  
  641.          Charles Cheong for  his invaluable suggestions  and extensive
  642.          beta testing in a ConfMail environment.
  643.  
  644.          Pete  Franchi  and  his  wife  for  their  invaluable help in
  645.          testing and forwarding PKMAS to the USA beta testers.
  646.  
  647.          Jason Steck for his  invaluable suggestions and help  in beta
  648.          testing.
  649.  
  650.          Robert Prowl for his encourage and lectures which started  me
  651.          off on C.
  652.  
  653.          Tan Hock Hai (Sergeant) for his suggestions on colour &  menu
  654.          design.
  655.  
  656.          Last but not least, Theresa Koh, my wife-to-be, for standing
  657.          by me thoughout this entire project.
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.  
  665.  
  666.  
  667.  
  668.  
  669.  
  670.  
  671.  
  672.  
  673.  
  674.  
  675.     ══════════════════════════════════════════════════════════════════
  676.                                                             APPENDIX D
  677.